/*
 * Released under "The BSD 3-Clause License"
 *
 * Copyright (c) 2021 cjiang. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above
 *    copyright notice, this list of conditions and the following
 *    disclaimer in the documentation and/or other materials provided
 *    with the distribution.
 * 3. The names of its contributors may not be used to endorse or promote
 *    products derived from this software without specific prior written
 *    permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 */

#ifndef _IOSKYWALKINTERFACE_H
#define _IOSKYWALKINTERFACE_H

#include <IOKit/IOService.h>

class IOSkywalkPacketQueue;
class IOSkywalkPacketBufferPool;

class IOSkywalkInterface : public IOService
{
    OSDeclareAbstractStructors( IOSkywalkInterface )
    
protected:
    virtual void free() APPLE_KEXT_OVERRIDE;
    virtual bool start( IOService * provider ) APPLE_KEXT_OVERRIDE;
    virtual void stop( IOService * provider ) APPLE_KEXT_OVERRIDE;
    virtual bool handleOpen( IOService * forClient, IOOptionBits options, void * arg ) APPLE_KEXT_OVERRIDE;
    virtual void handleClose( IOService * forClient, IOOptionBits options ) APPLE_KEXT_OVERRIDE;
    virtual bool handleIsOpen( const IOService * forClient ) const APPLE_KEXT_OVERRIDE;
    virtual IOReturn enable( IOOptionBits options ) = 0;
    virtual IOReturn disable( IOOptionBits options ) = 0;
    virtual IOReturn clientConnectWithTask( task_t task, IOService * forClient, IOOptionBits options );
    virtual void clientDisconnect( IOService * forClient, IOOptionBits options );
    
    IOReturn registerInterfaceWithQueues( IOSkywalkPacketQueue ** queue, UInt32 count, IOSkywalkPacketBufferPool * pool1, IOSkywalkPacketBufferPool * pool2, IOOptionBits options = 0 );
    IOReturn deregisterInterfaceWithQueues();
    
    OSMetaClassDeclareReservedUnused( IOSkywalkInterface,  0 );
    OSMetaClassDeclareReservedUnused( IOSkywalkInterface,  1 );
    OSMetaClassDeclareReservedUnused( IOSkywalkInterface,  2 );
    OSMetaClassDeclareReservedUnused( IOSkywalkInterface,  3 );
    OSMetaClassDeclareReservedUnused( IOSkywalkInterface,  4 );
    OSMetaClassDeclareReservedUnused( IOSkywalkInterface,  5 );
    OSMetaClassDeclareReservedUnused( IOSkywalkInterface,  6 );
    OSMetaClassDeclareReservedUnused( IOSkywalkInterface,  7 );
    OSMetaClassDeclareReservedUnused( IOSkywalkInterface,  8 );
    OSMetaClassDeclareReservedUnused( IOSkywalkInterface,  9 );
    OSMetaClassDeclareReservedUnused( IOSkywalkInterface, 10 );
    
protected:
    void                      * mReserved;          // 136
    OSArray                   * mPacketQueueArray;  // 144
    IOSkywalkPacketBufferPool * mPacketBufferPool1; // 152
    IOSkywalkPacketBufferPool * mPacketBufferPool2; // 160
    OSSet                     * mClients;           // 168
};

#endif
